/*
************************************************************************
*******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
**************  CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES  **************
*
*  (c) 2011.                            (c) 2011.
*  Government of Canada                 Gouvernement du Canada
*  National Research Council            Conseil national de recherches
*  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
*  All rights reserved                  Tous droits réservés
*
*  NRC disclaims any warranties,        Le CNRC dénie toute garantie
*  expressed, implied, or               énoncée, implicite ou légale,
*  statutory, of any kind with          de quelque nature que ce
*  respect to the software,             soit, concernant le logiciel,
*  including without limitation         y compris sans restriction
*  any warranty of merchantability      toute garantie de valeur
*  or fitness for a particular          marchande ou de pertinence
*  purpose. NRC shall not be            pour un usage particulier.
*  liable in any event for any          Le CNRC ne pourra en aucun cas
*  damages, whether direct or           être tenu responsable de tout
*  indirect, special or general,        dommage, direct ou indirect,
*  consequential or incidental,         particulier ou général,
*  arising from the use of the          accessoire ou fortuit, résultant
*  software.  Neither the name          de l'utilisation du logiciel. Ni
*  of the National Research             le nom du Conseil National de
*  Council of Canada nor the            Recherches du Canada ni les noms
*  names of its contributors may        de ses  participants ne peuvent
*  be used to endorse or promote        être utilisés pour approuver ou
*  products derived from this           promouvoir les produits dérivés
*  software without specific prior      de ce logiciel sans autorisation
*  written permission.                  préalable et particulière
*                                       par écrit.
*
*  This file is part of the             Ce fichier fait partie du projet
*  OpenCADC project.                    OpenCADC.
*
*  OpenCADC is free software:           OpenCADC est un logiciel libre ;
*  you can redistribute it and/or       vous pouvez le redistribuer ou le
*  modify it under the terms of         modifier suivant les termes de
*  the GNU Affero General Public        la “GNU Affero General Public
*  License as published by the          License” telle que publiée
*  Free Software Foundation,            par la Free Software Foundation
*  either version 3 of the              : soit la version 3 de cette
*  License, or (at your option)         licence, soit (à votre gré)
*  any later version.                   toute version ultérieure.
*
*  OpenCADC is distributed in the       OpenCADC est distribué
*  hope that it will be useful,         dans l’espoir qu’il vous
*  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
*  without even the implied             GARANTIE : sans même la garantie
*  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILITÉ
*  or FITNESS FOR A PARTICULAR          ni d’ADÉQUATION À UN OBJECTIF
*  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
*  General Public License for           Générale Publique GNU Affero
*  more details.                        pour plus de détails.
*
*  You should have received             Vous devriez avoir reçu une
*  a copy of the GNU Affero             copie de la Licence Générale
*  General Public License along         Publique GNU Affero avec
*  with OpenCADC.  If not, see          OpenCADC ; si ce n’est
*  <http://www.gnu.org/licenses/>.      pas le cas, consultez :
*                                       <http://www.gnu.org/licenses/>.
*
*  $Revision: 4 $
*
************************************************************************
*/

package ca.nrc.cadc.ad;

import ca.nrc.cadc.reg.client.RegistryClient;
import java.io.UnsupportedEncodingException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import java.net.URLEncoder;
import org.apache.log4j.Logger;

/**
 * SchemeHandler implementation for the Archive Directory (ad) system.
 * This class can convert an AD URI into a URL. This is an alternate version
 * that uses the RegistryClient to find the data web service base URL.
 *
 * @author pdowler
 */
public class AdSchemeHandler implements SchemeHandler
{
    private static final Logger log = Logger.getLogger(AdSchemeHandler.class);

    public static final String SCHEME = "ad";

    private static final String DATA_URI = "ivo://cadc.nrc.ca/data";
    private URI dataURI;

    private RegistryClient rc;
    private String baseHttpURL;
    private String baseHttpsURL;

    public AdSchemeHandler()
    {
        try
        {
            this.rc = new RegistryClient();
            this.dataURI = new URI(DATA_URI);
        }
        catch(Throwable t)
        {
            throw new RuntimeException("BUG: failed to init data service URI", t);
        }
    }


    /**
     * Convert a URI to a URL.
     *
     * @param uri the URI to convert to an URL.
     * @param secure generate a secure HTTP URL.
     * @throws IllegalArgumentException if the URI scheme is invalid
     * @see SchemeHandler#getURL(URI)
     * @return a URL to the identified resource
     */
    public URL getURL(URI uri, boolean secure)
    {
        if (!SCHEME.equals(uri.getScheme()))
            throw new IllegalArgumentException("invalid scheme in " + uri);

        String proto = "http";
        if (secure)
            proto = "https";
        try
        {
            String path = getPath(uri);
            URL url = rc.getServiceURL(dataURI, proto, path);
            log.debug(uri + " --> " + url);
            return url;
        }
        catch(MalformedURLException ex)
        {
            throw new RuntimeException("BUG", ex);
        }
    }
    
    private String getPath(URI uri)
    {
        String[]  path = uri.getSchemeSpecificPart().split("/");
        if (path.length != 2)
            throw new IllegalArgumentException("malformed AD URI, expected 2 path componets, found " + path.length);
        String arc = path[0];
        String fid = path[1];

        StringBuilder sb = new StringBuilder();
        sb.append("/pub/");
        sb.append(encodeString(arc));
        sb.append("/");
        sb.append(encodeString(fid));
        
        return sb.toString();
    }
    
    private static String encodeString(String str)
    {
        try { return URLEncoder.encode(str, "UTF-8"); }
        catch(UnsupportedEncodingException ignore) { }
        return null;
    }
    
}
